/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsrm.impl;

import org.apache.xmlbeans.XmlCursor;

import cgl.narada.wsinfra.exception.ParsingException;
import cgl.narada.wsinfra.exception.ProcessingException;
import cgl.narada.wsinfra.schemas.addressing.ActionDocument;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.schemas.soap.HeaderType;
import cgl.narada.wsinfra.util.QNameLocator;
import cgl.narada.wsinfra.wsa.AddressingHeaders;
import cgl.narada.wsinfra.wsa.ParseWsaHeaders;
import cgl.narada.wsinfra.wsa.WsaProcessingFactory;
import cgl.narada.wsinfra.wsrm.WsrmActions;
import cgl.narada.wsinfra.wsrm.WsrmExchangeInfo;
import cgl.narada.wsinfra.wsrm.WsrmExchangeInfoCreator;
import cgl.narada.wsinfra.wsrm.WsrmQNames;

/** This is a utility class which constructs a WsrmExchangeInfo based on
    the supplied Envelope Document.

    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:30 $
    $Revision: 1.3 $
*/

public class WsrmExchangeInfoCreatorImpl implements WsrmExchangeInfoCreator {
  private static WsrmExchangeInfoCreator instance = 
  new WsrmExchangeInfoCreatorImpl();
  
  private ParseWsaHeaders parseWsaHeaders;
  private WsrmActions wsrmActions;
  private WsrmQNames wsrmQNames;
  private QNameLocator qNameLocator;
  
  private String moduleName = "WsrmExchangeInfoCreator: ";
  
  private WsrmExchangeInfoCreatorImpl() {
    parseWsaHeaders = WsaProcessingFactory.getParseWsaHeaders();

    wsrmActions = WsrmActions.getInstance();
    wsrmQNames = WsrmQNames.getInstance();

    qNameLocator = QNameLocator.getInstance();
  }
  
  
  public static WsrmExchangeInfoCreator getInstance() {
    return instance;
  }

  /** Creates a WsrmExchangeInfo based on the supplied envelope */
  public WsrmExchangeInfo 
  createWsrmExchangeInfo(EnvelopeDocument envelopeDocument)
    throws ProcessingException {

    AddressingHeaders addressingHeaders;
    try {
      addressingHeaders =
	parseWsaHeaders.getAddressingHeaders(envelopeDocument);
    } catch (ParsingException parseEx) {
      throw new ProcessingException(moduleName + "Unable to process. " +
				    "Problems related to parsing \n" +
				    parseEx.getStackTraceAsString() );
    }
    
    WsrmExchangeInfoImpl wsrmExchangeInfo = 
      new WsrmExchangeInfoImpl(addressingHeaders);
    
    checkWsrmActionElements(wsrmExchangeInfo, addressingHeaders);
    checkForWsrmElements(wsrmExchangeInfo, envelopeDocument);

    return wsrmExchangeInfo;
  }

  
  /** Inspects the Action element contained within the Envelope to determine
      if it contains any of Wsrm action headers */
  private void 
  checkWsrmActionElements(WsrmExchangeInfoImpl wsrmExchangeInfo, 
			  AddressingHeaders addressingHeaders) {
    ActionDocument actionDocument = addressingHeaders.getAction();
    String action = null;
    
    if (actionDocument == null) {
      return;
    }

    action = actionDocument.getAction().getStringValue();
    if (action == null) {
      return;
    }
    
    if (action.equals(wsrmActions.getCreateSequence()) ) {
      wsrmExchangeInfo.setCreateSequence();
      return;
    }

    if (action.equals(wsrmActions.getCreateSequenceResponse()) ) {
      wsrmExchangeInfo.setCreateSequenceResponse();
      return;
    }

    if (action.equals(wsrmActions.getTerminateSequence()) ) {
      wsrmExchangeInfo.setTerminateSequence();
      return;
    }

  }
  

  private void checkForWsrmElements(WsrmExchangeInfoImpl wsrmExchangeInfo,
				    EnvelopeDocument envelopeDocument) {
    
    HeaderType header = envelopeDocument.getEnvelope().getHeader();
    XmlCursor headerCursor = header.newCursor();
    XmlCursor moveTo = header.newCursor();

    boolean elementFound = false;

    /** Locate the sequence element */
    elementFound = qNameLocator.locateQName(headerCursor, 
					    wsrmQNames.getSequence());
    if (elementFound) {
      wsrmExchangeInfo.setSequence();
      headerCursor.toCursor(moveTo);
    }

    /** Locate the ackRequested element */
    elementFound = 
      qNameLocator.locateQName(headerCursor, wsrmQNames.getAckRequested());
    if (elementFound) {
      wsrmExchangeInfo.setAckRequested();
      headerCursor.toCursor(moveTo);
    }

    /** Locate the sequence acknowledgement element */
    elementFound = 
      qNameLocator.locateQName(headerCursor, 
			       wsrmQNames.getSequenceAcknowledgement());
    if (elementFound) {
      wsrmExchangeInfo.setSequenceAcknowledgement();
      headerCursor.toCursor(moveTo);
    }
    
    headerCursor.dispose();
    moveTo.dispose();
  }

  private void repositionCursor(XmlCursor xmlCursor, int depth) {
    for (int i=0; i < depth; i++) {
      xmlCursor.pop();
    }

  }

}



